ODFocusSetIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODFocusSetIterator

Superclasses
ODObject
Subclasses
none

An object of the ODFocusSetIterator class provides access to all foci in a focus set.

Description
You use a focus-set iterator to apply an operation to all foci in a focus set. For example, you might store a focus set with all the foci owned by a given frame, and then use a focus-set iterator to search for a particular focus in the focus set.
Your part creates a focus-set iterator object by calling a focus set's CreateIterator method (page 288), which returns a reference to a focus-set iterator object.
While you are using a focus-set iterator, you should not modify or delete the focus set. You must postpone adding foci to or removing foci from the focus set until after you have deleted the iterator.
For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODFocusSetIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and returns the first focus in the focus set.
Next
Returns a reference to the next focus in the focus set.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Next